<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>scutimer: xscutimer_hw.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">scutimer
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xscutimer__hw_8h.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#define-members">Macros</a>  </div>
  <div class="headertitle">
<div class="title">xscutimer_hw.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:gae3cd5f68d2ce17dd72a4abaf4afe06a6"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__scutimer.html#gae3cd5f68d2ce17dd72a4abaf4afe06a6">XScuTimer_SetLoadReg</a>(BaseAddr, Value)&#160;&#160;&#160;<a class="el" href="group__scutimer.html#ga6f29815a4f21529bfc3d009932d3c2fe">XScuTimer_WriteReg</a>(BaseAddr, <a class="el" href="group__scutimer.html#gae86109b8ee86ede103995c458720c743">XSCUTIMER_LOAD_OFFSET</a>, (Value))</td></tr>
<tr class="memdesc:gae3cd5f68d2ce17dd72a4abaf4afe06a6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write to the timer load register.  <a href="group__scutimer.html#gae3cd5f68d2ce17dd72a4abaf4afe06a6">More...</a><br/></td></tr>
<tr class="separator:gae3cd5f68d2ce17dd72a4abaf4afe06a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3eedf4e335232d3303b1fd3927f10213"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__scutimer.html#ga3eedf4e335232d3303b1fd3927f10213">XScuTimer_GetLoadReg</a>(BaseAddr)&#160;&#160;&#160;<a class="el" href="group__scutimer.html#gae4c784baaac425e11d6a1184ae44b349">XScuTimer_ReadReg</a>(BaseAddr, <a class="el" href="group__scutimer.html#gae86109b8ee86ede103995c458720c743">XSCUTIMER_LOAD_OFFSET</a>)</td></tr>
<tr class="memdesc:ga3eedf4e335232d3303b1fd3927f10213"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the current timer load register value.  <a href="group__scutimer.html#ga3eedf4e335232d3303b1fd3927f10213">More...</a><br/></td></tr>
<tr class="separator:ga3eedf4e335232d3303b1fd3927f10213"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga162738ee853ef5fc9c4fa35bf9c2bb8d"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__scutimer.html#ga162738ee853ef5fc9c4fa35bf9c2bb8d">XScuTimer_SetCounterReg</a>(BaseAddr, Value)&#160;&#160;&#160;<a class="el" href="group__scutimer.html#ga6f29815a4f21529bfc3d009932d3c2fe">XScuTimer_WriteReg</a>(BaseAddr, <a class="el" href="group__scutimer.html#gaa96f9778b3fb95bb968793b504bee53e">XSCUTIMER_COUNTER_OFFSET</a>, (Value))</td></tr>
<tr class="memdesc:ga162738ee853ef5fc9c4fa35bf9c2bb8d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write to the timer counter register.  <a href="group__scutimer.html#ga162738ee853ef5fc9c4fa35bf9c2bb8d">More...</a><br/></td></tr>
<tr class="separator:ga162738ee853ef5fc9c4fa35bf9c2bb8d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga65cf8fca671de7e21a9944c43bf7cd8a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__scutimer.html#ga65cf8fca671de7e21a9944c43bf7cd8a">XScuTimer_GetCounterReg</a>(BaseAddr)&#160;&#160;&#160;<a class="el" href="group__scutimer.html#gae4c784baaac425e11d6a1184ae44b349">XScuTimer_ReadReg</a>(BaseAddr, <a class="el" href="group__scutimer.html#gaa96f9778b3fb95bb968793b504bee53e">XSCUTIMER_COUNTER_OFFSET</a>)</td></tr>
<tr class="memdesc:ga65cf8fca671de7e21a9944c43bf7cd8a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the current timer counter register value.  <a href="group__scutimer.html#ga65cf8fca671de7e21a9944c43bf7cd8a">More...</a><br/></td></tr>
<tr class="separator:ga65cf8fca671de7e21a9944c43bf7cd8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae0b71c6aa97a846b93c4a5fa2092be9e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__scutimer.html#gae0b71c6aa97a846b93c4a5fa2092be9e">XScuTimer_SetControlReg</a>(BaseAddr, Value)&#160;&#160;&#160;<a class="el" href="group__scutimer.html#ga6f29815a4f21529bfc3d009932d3c2fe">XScuTimer_WriteReg</a>(BaseAddr, <a class="el" href="group__scutimer.html#ga8f0a12cb3bfff490af76bc9a3ffca4be">XSCUTIMER_CONTROL_OFFSET</a>, (Value))</td></tr>
<tr class="memdesc:gae0b71c6aa97a846b93c4a5fa2092be9e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write to the timer load register.  <a href="group__scutimer.html#gae0b71c6aa97a846b93c4a5fa2092be9e">More...</a><br/></td></tr>
<tr class="separator:gae0b71c6aa97a846b93c4a5fa2092be9e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1427e7cc324917e9bc062ea9cc1976ac"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__scutimer.html#ga1427e7cc324917e9bc062ea9cc1976ac">XScuTimer_GetControlReg</a>(BaseAddr)&#160;&#160;&#160;<a class="el" href="group__scutimer.html#gae4c784baaac425e11d6a1184ae44b349">XScuTimer_ReadReg</a>(BaseAddr, <a class="el" href="group__scutimer.html#ga8f0a12cb3bfff490af76bc9a3ffca4be">XSCUTIMER_CONTROL_OFFSET</a>)</td></tr>
<tr class="memdesc:ga1427e7cc324917e9bc062ea9cc1976ac"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the current timer load register value.  <a href="group__scutimer.html#ga1427e7cc324917e9bc062ea9cc1976ac">More...</a><br/></td></tr>
<tr class="separator:ga1427e7cc324917e9bc062ea9cc1976ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaffc9febb953169fb57818c4c58fd68fc"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__scutimer.html#gaffc9febb953169fb57818c4c58fd68fc">XScuTimer_SetIntrReg</a>(BaseAddr, Value)&#160;&#160;&#160;<a class="el" href="group__scutimer.html#ga6f29815a4f21529bfc3d009932d3c2fe">XScuTimer_WriteReg</a>(BaseAddr, <a class="el" href="group__scutimer.html#ga79f4aab3a1968e66ae1fadb846e7b8c8">XSCUTIMER_ISR_OFFSET</a>, (Value))</td></tr>
<tr class="memdesc:gaffc9febb953169fb57818c4c58fd68fc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write to the timer counter register.  <a href="group__scutimer.html#gaffc9febb953169fb57818c4c58fd68fc">More...</a><br/></td></tr>
<tr class="separator:gaffc9febb953169fb57818c4c58fd68fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga48d158b4cc15416e7d4a62867720b79a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__scutimer.html#ga48d158b4cc15416e7d4a62867720b79a">XScuTimer_GetIntrReg</a>(BaseAddr)&#160;&#160;&#160;<a class="el" href="group__scutimer.html#gae4c784baaac425e11d6a1184ae44b349">XScuTimer_ReadReg</a>(BaseAddr, <a class="el" href="group__scutimer.html#ga79f4aab3a1968e66ae1fadb846e7b8c8">XSCUTIMER_ISR_OFFSET</a>)</td></tr>
<tr class="memdesc:ga48d158b4cc15416e7d4a62867720b79a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the current timer counter register value.  <a href="group__scutimer.html#ga48d158b4cc15416e7d4a62867720b79a">More...</a><br/></td></tr>
<tr class="separator:ga48d158b4cc15416e7d4a62867720b79a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae4c784baaac425e11d6a1184ae44b349"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__scutimer.html#gae4c784baaac425e11d6a1184ae44b349">XScuTimer_ReadReg</a>(BaseAddr, RegOffset)&#160;&#160;&#160;Xil_In32((BaseAddr) + (RegOffset))</td></tr>
<tr class="memdesc:gae4c784baaac425e11d6a1184ae44b349"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read from the given Timer register.  <a href="group__scutimer.html#gae4c784baaac425e11d6a1184ae44b349">More...</a><br/></td></tr>
<tr class="separator:gae4c784baaac425e11d6a1184ae44b349"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6f29815a4f21529bfc3d009932d3c2fe"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__scutimer.html#ga6f29815a4f21529bfc3d009932d3c2fe">XScuTimer_WriteReg</a>(BaseAddr, RegOffset, Data)&#160;&#160;&#160;Xil_Out32((BaseAddr) + (RegOffset), (Data))</td></tr>
<tr class="memdesc:ga6f29815a4f21529bfc3d009932d3c2fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write to the given Timer register.  <a href="group__scutimer.html#ga6f29815a4f21529bfc3d009932d3c2fe">More...</a><br/></td></tr>
<tr class="separator:ga6f29815a4f21529bfc3d009932d3c2fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">Register Map</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p>Offsets of registers from the start of the device </p>
</div></td></tr>
<tr class="memitem:gae86109b8ee86ede103995c458720c743"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__scutimer.html#gae86109b8ee86ede103995c458720c743">XSCUTIMER_LOAD_OFFSET</a>&#160;&#160;&#160;0x00U</td></tr>
<tr class="memdesc:gae86109b8ee86ede103995c458720c743"><td class="mdescLeft">&#160;</td><td class="mdescRight">Timer Load Register.  <a href="group__scutimer.html#gae86109b8ee86ede103995c458720c743">More...</a><br/></td></tr>
<tr class="separator:gae86109b8ee86ede103995c458720c743"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa96f9778b3fb95bb968793b504bee53e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__scutimer.html#gaa96f9778b3fb95bb968793b504bee53e">XSCUTIMER_COUNTER_OFFSET</a>&#160;&#160;&#160;0x04U</td></tr>
<tr class="memdesc:gaa96f9778b3fb95bb968793b504bee53e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Timer Counter Register.  <a href="group__scutimer.html#gaa96f9778b3fb95bb968793b504bee53e">More...</a><br/></td></tr>
<tr class="separator:gaa96f9778b3fb95bb968793b504bee53e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8f0a12cb3bfff490af76bc9a3ffca4be"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__scutimer.html#ga8f0a12cb3bfff490af76bc9a3ffca4be">XSCUTIMER_CONTROL_OFFSET</a>&#160;&#160;&#160;0x08U</td></tr>
<tr class="memdesc:ga8f0a12cb3bfff490af76bc9a3ffca4be"><td class="mdescLeft">&#160;</td><td class="mdescRight">Timer Control Register.  <a href="group__scutimer.html#ga8f0a12cb3bfff490af76bc9a3ffca4be">More...</a><br/></td></tr>
<tr class="separator:ga8f0a12cb3bfff490af76bc9a3ffca4be"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga79f4aab3a1968e66ae1fadb846e7b8c8"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__scutimer.html#ga79f4aab3a1968e66ae1fadb846e7b8c8">XSCUTIMER_ISR_OFFSET</a>&#160;&#160;&#160;0x0CU</td></tr>
<tr class="memdesc:ga79f4aab3a1968e66ae1fadb846e7b8c8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Timer Interrupt Status Register.  <a href="group__scutimer.html#ga79f4aab3a1968e66ae1fadb846e7b8c8">More...</a><br/></td></tr>
<tr class="separator:ga79f4aab3a1968e66ae1fadb846e7b8c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">Timer Control register</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p>This register bits control the prescaler, Intr enable, auto-reload and timer enable. </p>
</div></td></tr>
<tr class="memitem:ga867b2da6f5e9b1d921c34a925d4b498a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__scutimer.html#ga867b2da6f5e9b1d921c34a925d4b498a">XSCUTIMER_CONTROL_PRESCALER_MASK</a>&#160;&#160;&#160;0x0000FF00U</td></tr>
<tr class="memdesc:ga867b2da6f5e9b1d921c34a925d4b498a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prescaler.  <a href="group__scutimer.html#ga867b2da6f5e9b1d921c34a925d4b498a">More...</a><br/></td></tr>
<tr class="separator:ga867b2da6f5e9b1d921c34a925d4b498a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga31316fbcb2292f6d29c39a025bbd9821"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga31316fbcb2292f6d29c39a025bbd9821"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>XSCUTIMER_CONTROL_PRESCALER_SHIFT</b>&#160;&#160;&#160;8U</td></tr>
<tr class="separator:ga31316fbcb2292f6d29c39a025bbd9821"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga62c9d23e23b5329976291d26cc36c6a6"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__scutimer.html#ga62c9d23e23b5329976291d26cc36c6a6">XSCUTIMER_CONTROL_IRQ_ENABLE_MASK</a>&#160;&#160;&#160;0x00000004U</td></tr>
<tr class="memdesc:ga62c9d23e23b5329976291d26cc36c6a6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Intr enable.  <a href="group__scutimer.html#ga62c9d23e23b5329976291d26cc36c6a6">More...</a><br/></td></tr>
<tr class="separator:ga62c9d23e23b5329976291d26cc36c6a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaeaf7add0552b3b0c5ab78b6668a88d6a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__scutimer.html#gaeaf7add0552b3b0c5ab78b6668a88d6a">XSCUTIMER_CONTROL_AUTO_RELOAD_MASK</a>&#160;&#160;&#160;0x00000002U</td></tr>
<tr class="memdesc:gaeaf7add0552b3b0c5ab78b6668a88d6a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Auto-reload.  <a href="group__scutimer.html#gaeaf7add0552b3b0c5ab78b6668a88d6a">More...</a><br/></td></tr>
<tr class="separator:gaeaf7add0552b3b0c5ab78b6668a88d6a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga242deea9cc62049619bdfd97e7a731f4"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__scutimer.html#ga242deea9cc62049619bdfd97e7a731f4">XSCUTIMER_CONTROL_ENABLE_MASK</a>&#160;&#160;&#160;0x00000001U</td></tr>
<tr class="memdesc:ga242deea9cc62049619bdfd97e7a731f4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Timer enable.  <a href="group__scutimer.html#ga242deea9cc62049619bdfd97e7a731f4">More...</a><br/></td></tr>
<tr class="separator:ga242deea9cc62049619bdfd97e7a731f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">Interrupt Status register</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p>This register indicates the Timer counter register has reached zero. </p>
</div></td></tr>
<tr class="memitem:gafa21717c99e101943a7075d4e2e30ca1"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__scutimer.html#gafa21717c99e101943a7075d4e2e30ca1">XSCUTIMER_ISR_EVENT_FLAG_MASK</a>&#160;&#160;&#160;0x00000001U</td></tr>
<tr class="memdesc:gafa21717c99e101943a7075d4e2e30ca1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event flag.  <a href="group__scutimer.html#gafa21717c99e101943a7075d4e2e30ca1">More...</a><br/></td></tr>
<tr class="separator:gafa21717c99e101943a7075d4e2e30ca1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
